#ifndef EVENTS_HPP
#define EVENTS_HPP

/*******************************************************************************
 ** Name: events.hpp                                                       **
 ** Description:                                                              **
 **                                                                           **
 ** Open Source Initiative (OSI) Approved License                             **
 **                                                                           **
 **  Copyright (c) 2009-2011 B "Gian" James  <soap@government-sanctioned.us>  **
 **  All rights reserved.                                                     **
 **                                                                           **
 **  Redistribution and use in source and binary forms, with or without       **
 **  modification, are permitted provided that the following conditions are   **
 **  met:                                                                     **
 **                                                                           **
 **  * Redistributions of source code must retain the above copyright notice, **
 **    this list of conditions and the following disclaimer.                  **
 **  * Redistributions in binary form must reproduce the above copyright      **
 **    notice, this list of conditions and the following disclaimer in the    **
 **    documentation and/or other materials provided with the distribution.   **
 **                                                                           **
 **  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS      **
 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED **
 ** TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           **
 ** PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT        **
 ** HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,    **
 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED  **
 ** TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR    **
 ** PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    **
 ** LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      **
 ** NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        **
 ** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              **
 **                                                                           **
 ******************************************************************************/
// Modified $Date$ by $Author$
#include <queue>
#include <boost/signals2>

#define events_hpp_ID   "$Id$"

//! The enumeration of all supported events in the game
enum class EventType
{
	Unknown,
	AgencyJoined,
	AgencyQuit,
	AgencyBurned,
	AgencyDemoted,
	AgencyPromoted
};

//! The enumeration of all supported event triggers in the game
enum class TriggerType
{
	Unknown,
	Interaction,
	Proximity,
	TimeBased,
	EventBased,
	Initialization,
	SkillCheck,
	Environmental,
	Damage,
	Condition,
	Combat
};

typedef boost::signals2::signal<void ()> eventSignal;

// Base eventlistener structure
struct EventListener
{
	id_t	id;	// id of object wanting to listen
	virtual void operator ()() const
	{

	}
};

//! @class Event
//! @brief The given event to be fired
class Event
{
public:
	TriggerType & 	Trigger() { return trigger; }
	EventType &		Type() { return type; }
	eventSignal &	EventSignal() { return signal; }
	boost::signals2::connection Connect(EventListener* el) { return eventSignal.connect(el); }

protected:
	TriggerType		trigger;
	EventType		type;
	eventSignal 	signal;
};

// The global event queue
extern std::queue<Event> EventQueue;


#endif /* EVENTS_HPP */
